Move documentation to inline comments: GtkVSeparator
authorSteven Harms <sharms@ubuntu.com>
Wed, 3 Mar 2010 23:35:45 +0000 (18:35 -0500)
committerTristan Van Berkom <tristan.van.berkom@gmail.com>
Sun, 4 Apr 2010 00:59:00 +0000 (20:59 -0400)
Fixes https://bugzilla.gnome.org/show_bug.cgi?id=611662

docs/reference/gtk/tmpl/gtkvseparator.sgml [deleted file]
gtk/gtkvseparator.c
gtk/gtkvseparator.h

diff --git a/docs/reference/gtk/tmpl/gtkvseparator.sgml b/docs/reference/gtk/tmpl/gtkvseparator.sgml
deleted file mode 100644 (file)
index 02ce8b1..0000000
+++ /dev/null
@@ -1,41 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkVSeparator
-
-<!-- ##### SECTION Short_Description ##### -->
-A vertical separator
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-The #GtkVSeparator widget is a vertical separator, used to group the
-widgets within a window. It displays a vertical line with a shadow to
-make it appear sunken into the interface.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-<variablelist>
-<varlistentry>
-<term>#GtkHSeparator</term>
-<listitem><para>a horizontal separator.</para></listitem>
-</varlistentry>
-</variablelist>
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### STRUCT GtkVSeparator ##### -->
-<para>
-The #GtkVSeparator-struct struct contains private data only, and
-should be accessed using the functions below.
-</para>
-
-
-<!-- ##### FUNCTION gtk_vseparator_new ##### -->
-<para>
-Creates a new #GtkVSeparator.
-</para>
-
-@Returns: a new #GtkVSeparator.
-
-
index 855c1688cef8cb65f14393c42d87131b2bfa9f6e..77c3f59856fc6a84dc38c5b32293494edff815c8 100644 (file)
 #include "gtkvseparator.h"
 #include "gtkalias.h"
 
+/**
+ * SECTION:gtkvseparator
+ * @Short_description: A vertical separator
+ * @Title: GtkVSeparator
+ * @See_also: #GtkHSeparator
+ *
+ * The #GtkVSeparator widget is a vertical separator, used to group the
+ * widgets within a window. It displays a vertical line with a shadow to
+ * make it appear sunken into the interface.
+ */
+
 G_DEFINE_TYPE (GtkVSeparator, gtk_vseparator, GTK_TYPE_SEPARATOR)
 
 static void
@@ -44,6 +55,13 @@ gtk_vseparator_init (GtkVSeparator *vseparator)
                                   GTK_ORIENTATION_VERTICAL);
 }
 
+/**
+ * gtk_vseparator_new:
+ *
+ * Creates a new #GtkVSeparator.
+ *
+ * Returns: a new #GtkVSeparator.
+ */
 GtkWidget *
 gtk_vseparator_new (void)
 {
index ee97ee0690abcde0a3f704335837f8a981c326b0..a82ebfe10a09a0093892e5854ea19efd744437e1 100644 (file)
@@ -49,6 +49,12 @@ G_BEGIN_DECLS
 typedef struct _GtkVSeparator       GtkVSeparator;
 typedef struct _GtkVSeparatorClass  GtkVSeparatorClass;
 
+/**
+ * GtkVSeparator:
+ *
+ * The #GtkVSeparator struct contains private data only, and
+ * should be accessed using the functions below.
+ */
 struct _GtkVSeparator
 {
   GtkSeparator separator;